-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
2022-06-01-preview Operator Connect #18643
Conversation
Hi, @slpavkov Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Hi @slpavkov, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Some comments:
|
hi @JeffreyRichter these comments are all meaningful but im afraid that im not the owner of this api. I just need to add couple of missing properties for new feature we are building. So im curious how does that work? Is it so that whoever needs to change the swagger, needs also to update it to latest recommendations? I'm afraid of that, since any changes in the API (outside the ones i did - which is adding 3 properties in the PurchasedPhoneNumber dto) would mean more changes in UI and add a lot of work to my team in general. So how do the teams usually approach these situations? |
So first, it would be great if you could track down some PM or someone who owns this API and share my comments with them. Especially while this is in preview, we can easily make the kinds of changes I'm suggesting. Second, when you asked me to review this PR, what were you asking for? Just to review 3 new properties? If so, how would I have known to look for these? How would I know what they do or what data type they should be? I don't know what I was being asked to do and so I reviewed the whole of the API. |
19628a9
to
a8cdff0
Compare
Hi @JeffreyRichter, my apologies for not setting the context of the review and causing the confusion. All your comments deserve to be addressed but i would propose a compromise to postpone that to future when we do Public Preview or GA for ACS Operator Connect. You asked to pull into discussion people who are considered API owners so I'm adding @whisper6284 (Adrian Tang) who also made previous changes on the API and can answer any questions you might have. Please let us know if this proposal makes sense. |
Thanks for the explanation; I approved the PR. Yes you can postpone changing the API until before public preview. |
Thanks @JeffreyRichter for approval and for prompt response! I will fix the validation changes and later we can merge it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question/comment about the name of the isOperatorConnect parameter.
Other than that, based on the conversation LGTM
"purchaseDate", | ||
"partnerName", | ||
"partnerId", | ||
"isOperatorConnect" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can this be a more descriptive name of the parameter?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MushMal you are right its not a good name. We are actually planing to use Enum "NumberSource" instead with 2 values:
- CloudNumber (for numbers bought via MSFT)
- OperatorConnect (for numbers purchased with operators
Would that be acceptable? If not, can you elaborate more please?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of making this boolean an enum - easier to extend. Make sure you are using extensible enums https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#use-extensible-enums
The name itself can be anything like you have - phoneNumberType or phoneNumberSource..?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see you've made the changes already. Looks good
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @JeffreyRichter and @MushMal can this be merged? Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You have my LGTM. I would ask Jeffrey for his. You need two
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @MushMal we have two approval now, please merge if possible (i dont have the rights to do it). Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for the delay. Let me figure this out ASAP as I don't seem to have the merge rights either
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @MushMal any eta on when this can be merged please? Thanks!
d540e40
to
9e26786
Compare
8548b92
to
8b677a1
Compare
8904f40
to
e879d9e
Compare
5a77b88
to
4c964d9
Compare
fbe63b4
to
9958497
Compare
cc1d84c
to
6de2e5b
Compare
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.